<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>XmlRpc</title>
    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
    <link rel="stylesheet" type="text/css" href="css/VisDoc.css"/>
    <script src="js/doc.js" type="text/javascript">//</script>
  </head>
  <body pageId="Pagecom_orthogeneric_net_xmlrpc_XmlRpc">
    <div class="VisDoc"><span id="PageTop"><!----></span>
      <div class="content"><span class="accessKeysInfo"><span class="label"><a href="#" class="accessKeyInfoToggle" onclick="toggleAccessKeyInfo(); return true;">Access keys</a></span><span class="accessKeyLinks" style="display:none;"><a href="#PageTop" accesskey="t">T</a>op, <a href="#Summary" accesskey="s">S</a>ummary, <a href="#Constructor" accesskey="c">C</a>onstructors, 
Instance <a href="#Instanceproperties" accesskey="p">p</a>roperties, 
Instance <a href="#Instancemethods" accesskey="m">m</a>ethods, <a href="#Eventhandlers" accesskey="e">E</a>vent handlers</span></span><h1>XmlRpc</h1>
        <div class="classProperties">
          <table cellspacing="0">
            <tr>
              <th>Kind of class:</th>
              <td>class</td>
            </tr>
            <tr>
              <th>Inherits from:</th>
              <td>none</td>
            </tr>
            <tr>
              <th class="classDetails">Version:</th>
              <td class="classDetails">1.0a</td>
            </tr>
            <tr>
              <th class="classDetails">Author:</th>
              <td class="classDetails">florian.mlodzik@gmail.com</td>
            </tr>
            <tr>
              <th class="classDetails">Classpath:</th>
              <td class="classDetails">com.orthogeneric.net.xmlrpc.XmlRpc</td>
            </tr>
            <tr>
              <th class="classDetails">File last modified:</th>
              <td class="classDetails">Saturday, 29 July 2006, 01:12:36</td>
            </tr>
          </table>
        </div>
        <div class="classDescription">
          <div class="descriptionSummary">The XmlRpc-class is used to do XMLRPC's complying to the <a href="http://www.xmlrpc.com/spec">XMLRPC specification</a>.</div><br /> It acts as an interface to remote server-endpoints. <br /> Actionscript variables are marshalled to typed methodcalls and returned methodresponses can be unmarshalled/serialized to Actionscript types.     <div class="classFields">
            <div class="boxWithBorder">
              <div class="boxedElem">
                <div class="contentHolder"><span class="title">See also:</span><div class="item"><a href="http://http://www.xmlrpc.com/">www.xmlrpc.com</a></div>
                </div>
              </div>
            </div>
          </div>
        </div>
        <div class="summary hasBottomDivider">
          <h2 class="hasBottomDivider"><span id="Summary">Summary</span></h2>
          <div class="methodList">
            <div class="methodSummaryPart"><span class="title">Constructor</span><ul>
                <li>
                  <a href="#XmlRpc">XmlRpc</a>
                </li>
              </ul>
            </div>
            <div class="methodSummaryPart"><span class="title">Instance properties</span><ul>
                <li>
                  <a href="#uri">uri</a>
                </li>
              </ul>
            </div>
            <div class="methodSummaryPart"><span class="title">Instance methods</span><ul>
                <li>
                  <a href="#callMethod">callMethod</a>
                </li>
                <li>
                  <a href="#addEventListener">addEventListener</a>
                </li>
                <li>
                  <a href="#removeEventListener">removeEventListener</a>
                </li>
              </ul>
            </div>
            <div class="methodSummaryPart"><span class="title">Event handlers</span><ul>
                <li>
                  <a href="#onXmlRpcResult">onXmlRpcResult</a>
                </li>
                <li>
                  <a href="#onXmlRpcProgress">onXmlRpcProgress</a>
                </li>
                <li>
                  <a href="#onXmlRpcError">onXmlRpcError</a>
                </li>
              </ul>
            </div>
          </div>
        </div>
        <div class="methodSection">
          <h2 class="hasBottomDivider"><span id="Constructor">Constructor</span></h2>
          <div class="method hasBottomDivider">
            <h3 id="XmlRpc">XmlRpc</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code">function <b>XmlRpc</b> (
</div>
                <div><span class="code">url:String)</span></div>
              </div>
            </div>
            <div class="description">The XmlRpc-class constructor.</div>
            <div class="boxWithBorder">
              <div class="boxedElem">
                <div class="contentHolder"><span class="title">Parameters:</span><div class="item">
                    <div class="floatbox code colorizedCode">url<span class="itemSeparator">:</span></div>
                    <div>The URL of the service endpoint</div>
                  </div>
                </div>
              </div>
            </div>
          </div>
        </div>
        <div class="methodSection">
          <h2 class="hasBottomDivider"><span id="Instanceproperties">Instance properties</span></h2>
          <div class="method hasBottomDivider">
            <h3 id="uri">uri</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code"><b>uri</b>:String
</div>
                <div><span class="access">(read,write)</span></div>
              </div>
            </div>
            <div class="description">The XmlRpc-server endpoint</div>
          </div>
        </div>
        <div class="methodSection">
          <h2 class="hasBottomDivider"><span id="Instancemethods">Instance methods</span></h2>
          <div class="method hasBottomDivider">
            <h3 id="addEventListener">addEventListener</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code">function <b>addEventListener</b> (

</div>
                <div><span class="code">event:String,
listener:Object) : Void</span></div>
              </div>
            </div>
            <div class="description">The instance-method to register an object as a listener to an event dispatched by this XmlRpc-instance.<br /> Available events are:<br /> <br />   "onXmlRpcResult" - dispatched when a result from a remote method has been received<br />   "onXmlRpcProgress" - repeatedly dispatched during the retrieval of a method response<br />   "onXmlRpcError" - dispatched when an error (i.e. endpoint is not available) has occurred<br /></div>
          </div>
          <div class="method hasBottomDivider">
            <h3 id="callMethod">callMethod</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code">function <b>callMethod</b> (
</div>
                <div><span class="code">rMethod:String) : Void</span></div>
              </div>
            </div>
            <div class="description">The instance-method to invoke remote xml procedure calls. </div>
            <div class="boxWithBorder">
              <div class="boxedElem">
                <div class="contentHolder"><span class="title">Parameters:</span><div class="item">
                    <div class="floatbox code colorizedCode">rMethod   <span class="itemSeparator">:</span></div>
                    <div>The name of the remote method to invoke</div>
                  </div>
                  <div class="item">
                    <div class="floatbox code colorizedCode">(optional)<span class="itemSeparator">:</span></div>
                    <div>Any number of additional parameters for the remote method call</div>
                  </div>
                </div>
              </div>
            </div>
          </div>
          <div class="method hasBottomDivider">
            <h3 id="removeEventListener">removeEventListener</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code">function <b>removeEventListener</b> (

</div>
                <div><span class="code">event:String,
listener:Object) : Void</span></div>
              </div>
            </div>
            <div class="description">The instance-method to un-register an object as a listener to an event dispatched by this XmlRpc-instance.</div>
            <div class="boxWithBorder">
              <div class="boxedElem">
                <div class="contentHolder"><span class="title">See also:</span><div class="item">addEventListener()</div>
                </div>
              </div>
            </div>
          </div>
        </div>
        <div class="methodSection">
          <h2 class="hasBottomDivider"><span id="Eventhandlers">Event handlers</span></h2>
          <div class="method hasBottomDivider">
            <h3 id="onXmlRpcError">onXmlRpcError</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code">function <b>onXmlRpcError</b> (
</div>
                <div><span class="code">evt:<a href="com_orthogeneric_net_xmlrpc_events_XmlRpcError.html">XmlRpcError</a>) : Void</span></div>
              </div>
            </div>
            <div class="description">The instance-method that is being invoked when an error occured during the xmlrpc</div>
            <div class="boxWithBorder">
              <div class="boxedElem">
                <div class="contentHolder"><span class="title">See also:</span><div class="item"><a href="com_orthogeneric_net_xmlrpc_events_XmlRpcError.html">com.orthogeneric.net.xmlrpc.events.XmlRpcError</a></div>
                </div>
              </div>
            </div>
          </div>
          <div class="method hasBottomDivider">
            <h3 id="onXmlRpcProgress">onXmlRpcProgress</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code">function <b>onXmlRpcProgress</b> (
</div>
                <div><span class="code">evt:<a href="com_orthogeneric_net_xmlrpc_events_XmlRpcProgress.html">XmlRpcProgress</a>) : Void</span></div>
              </div>
            </div>
            <div class="description">The instance-method that is repeatedly being invoked during the loading of a xmlrpc response.</div>
            <div class="boxWithBorder">
              <div class="boxedElem">
                <div class="contentHolder"><span class="title">See also:</span><div class="item"><a href="com_orthogeneric_net_xmlrpc_events_XmlRpcProgress.html">com.orthogeneric.net.xmlrpc.events.XmlRpcProgress</a></div>
                </div>
              </div>
            </div>
          </div>
          <div class="method hasBottomDivider">
            <h3 id="onXmlRpcResult">onXmlRpcResult</h3>
            <div class="fullMemberString">
              <div class="clearfix floatholder">
                <div class="floatbox code">function <b>onXmlRpcResult</b> (
</div>
                <div><span class="code">evt:<a href="com_orthogeneric_net_xmlrpc_events_XmlRpcResult.html">XmlRpcResult</a>) : Void</span></div>
              </div>
            </div>
            <div class="description">The instance-method that is being invoked when a result has been received from the xmlrpc</div>
            <div class="boxWithBorder">
              <div class="boxedElem">
                <div class="contentHolder"><span class="title">See also:</span><div class="item"><a href="com_orthogeneric_net_xmlrpc_events_XmlRpcResult.html">com.orthogeneric.net.xmlrpc.events.XmlRpcResult</a></div>
                </div>
              </div>
            </div>
          </div>
        </div>
        <div class="footer"><span class="docFooter"><span class="copyright">&copy; 2006 Florian Mlodzik</span><span class="separator">|</span><span class="createdWith">Created with <a href="http://visiblearea.com/visdoc/">VisDoc</a></span><span class="separator">|</span><span class="creationDate">Saturday, 29 July 2006, 01:22:33</span><span class="separator">|</span><a href="#" onclick="showTOC(); return false;" class="showToc">show TOC</a><a href="#" onclick="hideTOC(); return false;" class="hideToc">hide TOC</a></span><span class="tocFooter">&copy; 2006 Florian Mlodzik<span class="separator">|</span><a href="#" onclick="hideTOC(); return false;" class="hideToc">hide TOC</a></span>
        </div>
      </div>
    </div>
  </body>
</html>
